Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixup docs publish job #850

Merged
merged 1 commit into from
Mar 30, 2023
Merged

Fixup docs publish job #850

merged 1 commit into from
Mar 30, 2023

Conversation

mtreinish
Copy link
Member

This commit fixes two separate issues in the docs publishing job. The first is a failure that happens in the docs deployment on releases. The IFS (internal field separator) variable was getting set too broadly at the the level of the entire script instead of just the tag parsing. This was causing the passing of the secrets for decrypting the credential files to fail. This commit updates the IFS usage so it's not affecting the other commands after we split the tag version.

The second change is updating the default sphinx-build invocation to include the -d flag to change the default output directory for the .doctrees dir.
(see: https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-d for details on the flag). The .doctrees dir is a local cache of pickle files for parsed source files and doesn't need to be included in the build. By moving the default location for this outside our html build dir this will remove a lot of overhead from our uploaded docs as this cache can end up being quite large.

This commit fixes two separate issues in the docs publishing job. The
first is a failure that happens in the docs deployment on releases.
The IFS (internal field separator) variable was getting set too broadly
at the the level of the entire script instead of just the tag parsing.
This was causing the passing of the secrets for decrypting the
credential files to fail. This commit updates the IFS usage so it's not
affecting the other commands after we split the tag version.

The second change is updating the default sphinx-build invocation to
include the -d flag to change the default output directory for the
.doctrees dir.
(see: https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-d
for details on the flag). The .doctrees dir is a local cache of pickle
files for parsed source files and doesn't need to be included in the
build. By moving the default location for this outside our html build dir
this will remove a lot of overhead from our uploaded docs as this cache
can end up being quite large.
Copy link
Collaborator

@IvanIsCoding IvanIsCoding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, after #843 we are uploading the docs to 3 different addresses so that doc parsing cache can really add up

@mtreinish mtreinish closed this Mar 30, 2023
@mtreinish mtreinish reopened this Mar 30, 2023
@mtreinish mtreinish added the automerge Queue a approved PR for merging label Mar 30, 2023
@coveralls
Copy link

Pull Request Test Coverage Report for Build 4563725135

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.02%) to 97.121%

Totals Coverage Status
Change from base Build 4554074638: -0.02%
Covered Lines: 13897
Relevant Lines: 14309

💛 - Coveralls

@mergify mergify bot merged commit a63042b into Qiskit:main Mar 30, 2023
@mtreinish mtreinish deleted the docs-fixes branch March 30, 2023 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Queue a approved PR for merging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants